Routines (alphabetical) > Object Classes > Graphics Object Classes > IDLgrPalette::NearestColor

IDLgrPalette::NearestColor

The IDLgrPalette::NearestColor function method returns the index of the palette color that best matches the given RGB values, using a simple squared-distance formula.

Syntax

Result = Obj->[IDLgrPalette::]NearestColor(Red, Green, Blue)

Return Value

Returns the index of the color in the palette that best matches the given RGB values. If Red, Green, and Blue are scalars then the result is a long integer. If Red, Green, and Blue are arrays then the result is a byte array.

Arguments

Red

A scalar or array giving the red values of the colors that should be matched. These values should be within the range of 0 to 255. For arrays the Red, Green, and Blue arguments should have the same number of elements.

Green

A scalar or array giving the green values of the colors that should be matched. These values should be within the range of 0 to 255. For arrays the Red, Green, and Blue arguments should have the same number of elements.

Blue

A scalar or array giving the blue values of the colors that should be matched. These values should be within the range of 0 to 255. For arrays the Red, Green, and Blue arguments should have the same number of elements.

Keywords

None

Version History

5.0	Introduced
8.5	Allow arguments to be arrays.

© 2015 Exelis Visual Information Solutions, Inc., a subsidiary of Harris Corporation. All Rights Reserved. This information is not subject to the controls of the International Traffic in Arms Regulations (ITAR) or the Export Administration Regulations (EAR). However, this information may be restricted from transfer to various embargoed countries under U.S. laws and regulations.